-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
dev: new way to fill the documentation #5986
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
+2,330
−1,371
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83b0cf8
to
5d8ab53
Compare
5d8ab53
to
58fd2e3
Compare
58fd2e3
to
dcc702e
Compare
bombsimon
reviewed
Aug 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Appreciate you documenting how these short codes work and their limitation.
Co-authored-by: Simon Sawert <[email protected]>
bombsimon
approved these changes
Aug 10, 2025
alexandear
approved these changes
Aug 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous method for filling data inside the documentation was cumbersome.
It was modifying the Markdown files directly by replacing placeholders with the actual data.
Also, the script to update the documentation was not able to run when the placeholders were already filled.
You were forced to reset the changes made by the script before modifying the files.
But when you modified the same files as the script and reverted the changes, all the changes were reverted.
So it was a pain.
The placeholders are removed from the files; instead, I replaced placeholders with shortcodes and partials that use the data from the dedicated files.
Now, modifying and running locally the documentation is easier.
There is more information about the new way to fill out the documentation on the dedicated page inside the website.
It was not easy to create this new way to fill in the documentation.
The Hugo documentation is complex.
I found bugs inside the theme, and I had to fix them.
There are also a few improvements:
Fixes #4683
Follows #5965